GET Forms?assetId={assetId}&formTypeId={formTypeId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}&includeAttachmentContent={includeAttachmentContent}
Retrieves forms for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetId |
Id of the asset |
globally unique identifier |
None. |
formTypeId |
Id of the form type |
globally unique identifier |
None. |
take |
Number of forms to retrieve. Default is all forms |
integer |
None. |
skip |
Number of forms to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the forms before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
|
includeAttachmentContent |
Include the file contents of the form field values if applicable |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
On success, a list of forms.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of Form |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "FormId": "0ca44a7a-d0da-447a-8329-2d27f03cc14e", "Asset": { "AssetId": "965808ad-5767-43c2-b179-c01a8229e906", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "669b0007-089c-4235-9aaa-cdbe09b9796f", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "c7c690e2-1edc-47dd-9b2e-85249bf9d1e2", "CreateDate": "2024-05-04T12:16:32.6959621-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-04T12:16:32.6959621-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "c44c6d27-18e4-4e26-b746-e48ea751b54d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-04T12:16:32.6959621-07:00", "MeasurementValueNeededDate": "2024-05-04T12:16:32.6959621-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7636af92-3289-4a56-8013-fb4c5f68f522", "CreateDate": "2024-05-04T12:16:32.6959621-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T12:16:32.6959621-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-05-04T12:16:32.6959621-07:00", "MeasurementValueNeededDate": "2024-05-04T12:16:32.6959621-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "91a0ffe7-4261-4fbe-be7a-59135e2f0431", "CreateDate": "2024-05-04T12:16:32.6959621-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-04T12:16:32.6959621-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "971c3f85-91f6-43ae-be35-d20806366c3d", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "669b0007-089c-4235-9aaa-cdbe09b9796f", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "c7c690e2-1edc-47dd-9b2e-85249bf9d1e2", "CreateDate": "2024-05-04T12:16:32.6959621-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-04T12:16:32.6959621-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-05-04T12:16:32.6959621-07:00", "Fields": [ { "FormTypeFieldId": "093539c0-08e1-4ed3-8a38-fe3c772e05f1", "Section": { "FormTypeSectionId": "f4c45fcd-46e7-4c8a-8772-8ab114590713", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "4a0b513e-9780-4589-a466-97a53716375b", "Name": "sample string 1" }, "Unit": { "UnitId": "8705d5e0-9de6-4f23-9bec-4d4ddd5f6484", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "aee0effb-5a1b-4e91-963a-bb46c0aa64ab", "CreateDate": "2024-05-04T12:16:32.6959621-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T12:16:32.6959621-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" }, { "FormTypeFieldId": "093539c0-08e1-4ed3-8a38-fe3c772e05f1", "Section": { "FormTypeSectionId": "f4c45fcd-46e7-4c8a-8772-8ab114590713", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "4a0b513e-9780-4589-a466-97a53716375b", "Name": "sample string 1" }, "Unit": { "UnitId": "8705d5e0-9de6-4f23-9bec-4d4ddd5f6484", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "aee0effb-5a1b-4e91-963a-bb46c0aa64ab", "CreateDate": "2024-05-04T12:16:32.6959621-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T12:16:32.6959621-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" } ], "SourceSystemId": "sample string 3", "CompanyId": "3adc82e5-292d-4262-bc35-9a5399ed46ac", "CreateDate": "2024-05-04T12:16:32.6959621-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T12:16:32.6959621-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-05-04T12:16:32.6959621-07:00", "Location": "sample string 1", "TaskId": "75505dd2-3db1-4d6e-9c83-0f75c6c63bdc", "Values": [ { "FormFieldValueId": "3926c471-581b-4ce0-813d-1eb41edbc289", "FormTypeField": { "FormTypeFieldId": "093539c0-08e1-4ed3-8a38-fe3c772e05f1", "Section": { "FormTypeSectionId": "f4c45fcd-46e7-4c8a-8772-8ab114590713", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "4a0b513e-9780-4589-a466-97a53716375b", "Name": "sample string 1" }, "Unit": { "UnitId": "8705d5e0-9de6-4f23-9bec-4d4ddd5f6484", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "aee0effb-5a1b-4e91-963a-bb46c0aa64ab", "CreateDate": "2024-05-04T12:16:32.6959621-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T12:16:32.6959621-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" }, "SectionIndex": 1, "FieldIndex": 1, "FileName": "sample string 1", "FileType": "sample string 2", "FileSize": 1, "FileContent": "QEA=", "ValueText": "sample string 3", "IsValid": true, "IsValidMessage": "sample string 5", "SourceSystemId": "sample string 6" }, { "FormFieldValueId": "3926c471-581b-4ce0-813d-1eb41edbc289", "FormTypeField": { "FormTypeFieldId": "093539c0-08e1-4ed3-8a38-fe3c772e05f1", "Section": { "FormTypeSectionId": "f4c45fcd-46e7-4c8a-8772-8ab114590713", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "4a0b513e-9780-4589-a466-97a53716375b", "Name": "sample string 1" }, "Unit": { "UnitId": "8705d5e0-9de6-4f23-9bec-4d4ddd5f6484", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "aee0effb-5a1b-4e91-963a-bb46c0aa64ab", "CreateDate": "2024-05-04T12:16:32.6959621-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T12:16:32.6959621-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" }, "SectionIndex": 1, "FieldIndex": 1, "FileName": "sample string 1", "FileType": "sample string 2", "FileSize": 1, "FileContent": "QEA=", "ValueText": "sample string 3", "IsValid": true, "IsValidMessage": "sample string 5", "SourceSystemId": "sample string 6" } ], "SourceSystemId": "sample string 2", "CompanyId": "fe98eb7d-7533-415a-8d5e-af3e452df7e3", "CreateDate": "2024-05-04T12:16:32.6959621-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-04T12:16:32.6959621-07:00", "LastModifiedUser": "sample string 5" }, { "FormId": "0ca44a7a-d0da-447a-8329-2d27f03cc14e", "Asset": { "AssetId": "965808ad-5767-43c2-b179-c01a8229e906", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "669b0007-089c-4235-9aaa-cdbe09b9796f", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "c7c690e2-1edc-47dd-9b2e-85249bf9d1e2", "CreateDate": "2024-05-04T12:16:32.6959621-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-04T12:16:32.6959621-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "c44c6d27-18e4-4e26-b746-e48ea751b54d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-04T12:16:32.6959621-07:00", "MeasurementValueNeededDate": "2024-05-04T12:16:32.6959621-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7636af92-3289-4a56-8013-fb4c5f68f522", "CreateDate": "2024-05-04T12:16:32.6959621-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T12:16:32.6959621-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-05-04T12:16:32.6959621-07:00", "MeasurementValueNeededDate": "2024-05-04T12:16:32.6959621-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "91a0ffe7-4261-4fbe-be7a-59135e2f0431", "CreateDate": "2024-05-04T12:16:32.6959621-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-04T12:16:32.6959621-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "971c3f85-91f6-43ae-be35-d20806366c3d", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "669b0007-089c-4235-9aaa-cdbe09b9796f", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "c7c690e2-1edc-47dd-9b2e-85249bf9d1e2", "CreateDate": "2024-05-04T12:16:32.6959621-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-04T12:16:32.6959621-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-05-04T12:16:32.6959621-07:00", "Fields": [ { "FormTypeFieldId": "093539c0-08e1-4ed3-8a38-fe3c772e05f1", "Section": { "FormTypeSectionId": "f4c45fcd-46e7-4c8a-8772-8ab114590713", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "4a0b513e-9780-4589-a466-97a53716375b", "Name": "sample string 1" }, "Unit": { "UnitId": "8705d5e0-9de6-4f23-9bec-4d4ddd5f6484", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "aee0effb-5a1b-4e91-963a-bb46c0aa64ab", "CreateDate": "2024-05-04T12:16:32.6959621-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T12:16:32.6959621-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" }, { "FormTypeFieldId": "093539c0-08e1-4ed3-8a38-fe3c772e05f1", "Section": { "FormTypeSectionId": "f4c45fcd-46e7-4c8a-8772-8ab114590713", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "4a0b513e-9780-4589-a466-97a53716375b", "Name": "sample string 1" }, "Unit": { "UnitId": "8705d5e0-9de6-4f23-9bec-4d4ddd5f6484", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "aee0effb-5a1b-4e91-963a-bb46c0aa64ab", "CreateDate": "2024-05-04T12:16:32.6959621-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T12:16:32.6959621-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" } ], "SourceSystemId": "sample string 3", "CompanyId": "3adc82e5-292d-4262-bc35-9a5399ed46ac", "CreateDate": "2024-05-04T12:16:32.6959621-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T12:16:32.6959621-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-05-04T12:16:32.6959621-07:00", "Location": "sample string 1", "TaskId": "75505dd2-3db1-4d6e-9c83-0f75c6c63bdc", "Values": [ { "FormFieldValueId": "3926c471-581b-4ce0-813d-1eb41edbc289", "FormTypeField": { "FormTypeFieldId": "093539c0-08e1-4ed3-8a38-fe3c772e05f1", "Section": { "FormTypeSectionId": "f4c45fcd-46e7-4c8a-8772-8ab114590713", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "4a0b513e-9780-4589-a466-97a53716375b", "Name": "sample string 1" }, "Unit": { "UnitId": "8705d5e0-9de6-4f23-9bec-4d4ddd5f6484", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "aee0effb-5a1b-4e91-963a-bb46c0aa64ab", "CreateDate": "2024-05-04T12:16:32.6959621-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T12:16:32.6959621-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" }, "SectionIndex": 1, "FieldIndex": 1, "FileName": "sample string 1", "FileType": "sample string 2", "FileSize": 1, "FileContent": "QEA=", "ValueText": "sample string 3", "IsValid": true, "IsValidMessage": "sample string 5", "SourceSystemId": "sample string 6" }, { "FormFieldValueId": "3926c471-581b-4ce0-813d-1eb41edbc289", "FormTypeField": { "FormTypeFieldId": "093539c0-08e1-4ed3-8a38-fe3c772e05f1", "Section": { "FormTypeSectionId": "f4c45fcd-46e7-4c8a-8772-8ab114590713", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "4a0b513e-9780-4589-a466-97a53716375b", "Name": "sample string 1" }, "Unit": { "UnitId": "8705d5e0-9de6-4f23-9bec-4d4ddd5f6484", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "aee0effb-5a1b-4e91-963a-bb46c0aa64ab", "CreateDate": "2024-05-04T12:16:32.6959621-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T12:16:32.6959621-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" }, "SectionIndex": 1, "FieldIndex": 1, "FileName": "sample string 1", "FileType": "sample string 2", "FileSize": 1, "FileContent": "QEA=", "ValueText": "sample string 3", "IsValid": true, "IsValidMessage": "sample string 5", "SourceSystemId": "sample string 6" } ], "SourceSystemId": "sample string 2", "CompanyId": "fe98eb7d-7533-415a-8d5e-af3e452df7e3", "CreateDate": "2024-05-04T12:16:32.6959621-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-04T12:16:32.6959621-07:00", "LastModifiedUser": "sample string 5" } ], "Total": 1, "Message": "sample string 1" }